home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpui.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  3.2 KB  |  86 lines
  1. <refentry id="libgimp-gimpui" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpui</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpui</refname><refpurpose>Common user interface functions. This header includes all other GIMP User
  10. Interface Library headers.</refpurpose>
  11. </refnamediv>
  12.  
  13. <refsynopsisdiv><title>Synopsis</title>
  14. <synopsis>
  15.  
  16.  
  17.  
  18. void        <link linkend="gimp-ui-init">gimp_ui_init</link>                    (const <link linkend="gchar">gchar</link> *prog_name,
  19.                                              <link linkend="gboolean">gboolean</link> preview);
  20. </synopsis>
  21. </refsynopsisdiv>
  22.  
  23.  
  24.  
  25.  
  26.  
  27. <refsect1>
  28. <title>Description</title>
  29. <para>
  30. Common user interface functions. This header includes all other GIMP User
  31. Interface Library headers.
  32.  
  33. </para>
  34. </refsect1>
  35.  
  36. <refsect1>
  37. <title>Details</title>
  38. <refsect2>
  39. <title><anchor id="gimp-ui-init">gimp_ui_init ()</title>
  40. <programlisting>void        gimp_ui_init                    (const <link linkend="gchar">gchar</link> *prog_name,
  41.                                              <link linkend="gboolean">gboolean</link> preview);</programlisting>
  42. <para>
  43. This function initializes GTK+ with <link linkend="gtk-init">gtk_init</link>(), instructs GDK not to
  44. use X shared memory if The GIMP was invoked with the --no-xshm command
  45. line option and initializes GDK's image rendering subsystem (GdkRGB) to
  46. follow the GIMP main program's colormap allocation/installation policy.
  47. </para>
  48. <para>
  49. The GIMP's colormap policy can be determinded by the user with the
  50. gimprc variables <parameter>min_colors</parameter> and <parameter>install_cmap</parameter>.</para>
  51. <para>
  52.  
  53. </para><informaltable pgwide=1 frame="none" role="params">
  54. <tgroup cols="2">
  55. <colspec colwidth="2*">
  56. <colspec colwidth="8*">
  57. <tbody>
  58. <row><entry align="right"><parameter>prog_name</parameter> :</entry>
  59. <entry> The name of the plug-in which will be passed as argv[0] to
  60. <link linkend="gtk-init">gtk_init</link>(). It's a convention to use the name of the
  61. executable and _not_ the PDB procedure name or something.
  62. </entry></row>
  63. <row><entry align="right"><parameter>preview</parameter> :</entry>
  64. <entry> <link linkend="TRUE-CAPS">TRUE</link> if the plug-in has some kind of preview in it's UI.
  65. Note that passing <link linkend="TRUE-CAPS">TRUE</link> is recommended also if one of the
  66. used GIMP Library widgets contains a preview (like the image
  67. menu returned by <link linkend="gimp-image-menu-new">gimp_image_menu_new</link>()).
  68. </entry></row>
  69. </tbody></tgroup></informaltable></refsect2>
  70.  
  71. </refsect1>
  72.  
  73.  
  74.  
  75. <refsect1>
  76. <title>See Also</title>
  77. <para>
  78. <link linkend="gtk-init">gtk_init</link>(), <link linkend="gdk-set-use-xshm">gdk_set_use_xshm</link>(), <link linkend="gdk-rgb-set-min-colors">gdk_rgb_set_min_colors</link>(),
  79. <link linkend="gdk-rgb-set-install">gdk_rgb_set_install</link>(), <link linkend="gdk-rgb-get-visual">gdk_rgb_get_visual</link>(), <link linkend="gdk-rgb-get-cmap">gdk_rgb_get_cmap</link>(),
  80. <link linkend="gtk-widget-set-default-visual">gtk_widget_set_default_visual</link>(), <link linkend="gtk-widget-set-default-colormap">gtk_widget_set_default_colormap</link>(),
  81. <link linkend="gtk-preview-set-gamma">gtk_preview_set_gamma</link>().
  82. </para>
  83. </refsect1>
  84.  
  85. </refentry>
  86.